/*
* Copyright (c) 2021, Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
//!
//! \file     decode_mpeg2_packet_xe2_lpm_base.cpp
//! \brief    Defines the interface for mpeg2 decode packet of Xe2_LPM+
//!

#include "decode_mpeg2_packet_xe2_lpm_base.h"
#include "decode_utils.h"
#include "decode_mpeg2_pipeline.h"
#include "decode_mpeg2_basic_feature.h"
#include "decode_status_report_defs.h"
#include "mos_solo_generic.h"
#include "decode_status_report_defs.h"
#include "decode_resource_auto_lock.h"
#include "hal_oca_interface_next.h"

namespace decode
{
    MOS_STATUS Mpeg2DecodePktXe2_Lpm_Base::Submit(
        MOS_COMMAND_BUFFER* cmdBuffer,
        uint8_t             packetPhase)
    {
        DECODE_FUNC_CALL();

        PERF_UTILITY_AUTO(__FUNCTION__, PERF_DECODE, PERF_LEVEL_HAL);

        DECODE_CHK_NULL(cmdBuffer);
        DECODE_CHK_NULL(m_hwInterface);

        DECODE_CHK_STATUS(m_miItf->SetWatchdogTimerThreshold(
            m_mpeg2BasicFeature->m_width, m_mpeg2BasicFeature->m_height, false));

        DECODE_CHK_STATUS(Mos_Solo_PreProcessDecode(m_osInterface, &m_mpeg2BasicFeature->m_destSurface));

        if (IsPrologRequired())
        {
            DECODE_CHK_STATUS(AddForceWakeup(*cmdBuffer));
            DECODE_CHK_STATUS(SendPrologWithFrameTracking(*cmdBuffer, true));
        }

        DECODE_CHK_NULL(m_hwInterface->GetVdencInterfaceNext());
        auto mmioRegisters = m_hwInterface->GetVdencInterfaceNext()->GetMmioRegisters(MHW_VDBOX_NODE_1);
        HalOcaInterfaceNext::On1stLevelBBStart(*cmdBuffer, (MOS_CONTEXT_HANDLE)m_osInterface->pOsContext, m_osInterface->CurrentGpuContextHandle, m_miItf, *mmioRegisters);
        HalOcaInterfaceNext::OnDispatch(*cmdBuffer, *m_osInterface, m_miItf, *m_miItf->GetMmioRegisters());

        DECODE_CHK_STATUS(PackPictureLevelCmds(*cmdBuffer));

        if (m_mpeg2BasicFeature->m_mode == CODECHAL_DECODE_MODE_MPEG2VLD)
        {
            DECODE_CHK_STATUS(PackSliceLevelCmds(*cmdBuffer));
        }
        else if (m_mpeg2BasicFeature->m_mode == CODECHAL_DECODE_MODE_MPEG2IDCT)
        {
            DECODE_CHK_STATUS(PackMbLevelCmds(*cmdBuffer));
        }
        else
        {
            DECODE_ASSERTMESSAGE(" Unspported decode mode for mpeg2");
            return MOS_STATUS_INVALID_PARAMETER;
        }

        HalOcaInterfaceNext::On1stLevelBBEnd(*cmdBuffer, *m_osInterface);
        DECODE_CHK_STATUS(m_allocator->SyncOnResource(&m_mpeg2BasicFeature->m_resDataBuffer, false));
        DECODE_CHK_STATUS(Mos_Solo_PostProcessDecode(m_osInterface, &m_mpeg2BasicFeature->m_destSurface));

        return MOS_STATUS_SUCCESS;
    }

    MOS_STATUS Mpeg2DecodePktXe2_Lpm_Base::PackPictureLevelCmds(MOS_COMMAND_BUFFER& cmdBuffer)
    {
        DECODE_FUNC_CALL();

        PERF_UTILITY_AUTO(__FUNCTION__, PERF_DECODE, PERF_LEVEL_HAL);

        DECODE_CHK_STATUS(StartStatusReport(statusReportMfx, &cmdBuffer));
        DECODE_CHK_STATUS(m_picturePkt->Execute(cmdBuffer));

        return MOS_STATUS_SUCCESS;
    }

    MOS_STATUS Mpeg2DecodePktXe2_Lpm_Base::PackSliceLevelCmds(MOS_COMMAND_BUFFER& cmdBuffer)
    {
        DECODE_FUNC_CALL();

        PERF_UTILITY_AUTO(__FUNCTION__, PERF_DECODE, PERF_LEVEL_HAL);

        PMHW_BATCH_BUFFER batchBuf = m_secondLevelBBArray->Fetch();
        DECODE_CHK_NULL(batchBuf);

        DECODE_CHK_STATUS(m_miItf->ADDCMD_MI_BATCH_BUFFER_START(&cmdBuffer, batchBuf));
        DECODE_CHK_STATUS(Mhw_LockBb(m_osInterface, batchBuf));

        for (uint16_t slcIdx = 0; slcIdx < m_mpeg2BasicFeature->m_totalNumSlicesRecv; slcIdx++)
        {
            DECODE_CHK_STATUS(m_slicePkt->Execute(*batchBuf, slcIdx));
        }

        DECODE_CHK_STATUS(m_miItf->AddMiBatchBufferEnd(nullptr, batchBuf));
        DECODE_CHK_STATUS(Mhw_UnlockBb(m_osInterface, batchBuf, true));

        DECODE_CHK_STATUS(EnsureAllCommandsExecuted(cmdBuffer));
        DECODE_CHK_STATUS(EndStatusReport(statusReportMfx, &cmdBuffer));
        DECODE_CHK_STATUS(UpdateStatusReportNext(statusReportGlobalCount, &cmdBuffer));

        DECODE_CHK_STATUS(m_miItf->AddMiBatchBufferEnd(&cmdBuffer, nullptr));

        return MOS_STATUS_SUCCESS;
    }

    MOS_STATUS Mpeg2DecodePktXe2_Lpm_Base::PackMbLevelCmds(MOS_COMMAND_BUFFER& cmdBuffer)
    {
        DECODE_FUNC_CALL();

        PERF_UTILITY_AUTO(__FUNCTION__, PERF_DECODE, PERF_LEVEL_HAL);

        PMHW_BATCH_BUFFER batchBuf = m_secondLevelBBArray->Fetch();
        DECODE_CHK_NULL(batchBuf);

        DECODE_CHK_STATUS(m_miItf->ADDCMD_MI_BATCH_BUFFER_START(&cmdBuffer, batchBuf));
        DECODE_CHK_STATUS(Mhw_LockBb(m_osInterface, batchBuf));

        for (uint32_t mbIdx = 0; mbIdx < m_mpeg2BasicFeature->m_totalNumMbsRecv; mbIdx++)
        {
            DECODE_CHK_STATUS(m_mbPkt->Execute(*batchBuf, mbIdx));
        }

        DECODE_CHK_STATUS(m_miItf->AddMiBatchBufferEnd(nullptr, batchBuf));
        DECODE_CHK_STATUS(Mhw_UnlockBb(m_osInterface, batchBuf, true));

        DECODE_CHK_STATUS(EnsureAllCommandsExecuted(cmdBuffer));
        DECODE_CHK_STATUS(EndStatusReport(statusReportMfx, &cmdBuffer));
        DECODE_CHK_STATUS(UpdateStatusReportNext(statusReportGlobalCount, &cmdBuffer));

        DECODE_CHK_STATUS(m_miItf->AddMiBatchBufferEnd(&cmdBuffer, nullptr));

        return MOS_STATUS_SUCCESS;
    }

    MOS_STATUS Mpeg2DecodePktXe2_Lpm_Base::EnsureAllCommandsExecuted(MOS_COMMAND_BUFFER& cmdBuffer)
    {
        DECODE_FUNC_CALL();

        // Send MI_FLUSH command
        auto &par = m_miItf->GETPAR_MI_FLUSH_DW();
        par       = {};
        auto *skuTable = m_mpeg2Pipeline->GetSkuTable();
        if (skuTable && MEDIA_IS_SKU(skuTable, FtrEnablePPCFlush))
        {
            // Add PPC fulsh
            par.bEnablePPCFlush = true;
        }
        DECODE_CHK_STATUS(m_miItf->ADDCMD_MI_FLUSH_DW(&cmdBuffer));

        return MOS_STATUS_SUCCESS;
    }

}  // namespace decode
